<!DOCTYPE html>
<html lang="en-us">
  <head>

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    
<meta charset="UTF-8">
<title>cat transforms API | Elasticsearch Guide [7.7] | Elastic</title>
<link rel="home" href="index.html" title="Elasticsearch Guide [7.7]">
<link rel="up" href="cat.html" title="cat APIs">
<link rel="prev" href="cat-trained-model.html" title="cat trained model API">
<link rel="next" href="cluster.html" title="Cluster APIs">
<meta name="DC.type" content="Learn/Docs/Elasticsearch/Reference/7.7">
<meta name="DC.subject" content="Elasticsearch">
<meta name="DC.identifier" content="7.7">
<meta name="robots" content="noindex,nofollow">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script src="https://cdn.optimizely.com/js/18132920325.js"></script>
    <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
    <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
    <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
    <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
    <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
    <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
    <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
    <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
    <link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
    <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
    <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
    <link rel="manifest" href="/manifest.json">
    <meta name="apple-mobile-web-app-title" content="Elastic">
    <meta name="application-name" content="Elastic">
    <meta name="msapplication-TileColor" content="#ffffff">
    <meta name="msapplication-TileImage" content="/mstile-144x144.png">
    <meta name="theme-color" content="#ffffff">
    <meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd">
    <meta name="yandex-verification" content="d8a47e95d0972434">
    <meta name="localized" content="true">
    <meta name="st:robots" content="follow,index">
    <meta property="og:image" content="https://www.elastic.co/static/images/elastic-logo-200.png">
    <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
    <link rel="icon" href="/favicon.ico" type="image/x-icon">
    <link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
    <link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
    <link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
    <link rel="stylesheet" type="text/css" href="/guide/static/styles.css">
  </head>

  <!--© 2015-2021 Elasticsearch B.V. Copying, publishing and/or distributing without written permission is strictly prohibited.-->

  <body>
    <!-- Google Tag Manager -->
    <script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
    <!-- End Google Tag Manager -->

    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', 'UA-12395217-16');
    </script>

    <!--BEGIN QUALTRICS WEBSITE FEEDBACK SNIPPET-->
    <script type="text/javascript">
      (function(){var g=function(e,h,f,g){
      this.get=function(a){for(var a=a+"=",c=document.cookie.split(";"),b=0,e=c.length;b<e;b++){for(var d=c[b];" "==d.charAt(0);)d=d.substring(1,d.length);if(0==d.indexOf(a))return d.substring(a.length,d.length)}return null};
      this.set=function(a,c){var b="",b=new Date;b.setTime(b.getTime()+6048E5);b="; expires="+b.toGMTString();document.cookie=a+"="+c+b+"; path=/; "};
      this.check=function(){var a=this.get(f);if(a)a=a.split(":");else if(100!=e)"v"==h&&(e=Math.random()>=e/100?0:100),a=[h,e,0],this.set(f,a.join(":"));else return!0;var c=a[1];if(100==c)return!0;switch(a[0]){case "v":return!1;case "r":return c=a[2]%Math.floor(100/c),a[2]++,this.set(f,a.join(":")),!c}return!0};
      this.go=function(){if(this.check()){var a=document.createElement("script");a.type="text/javascript";a.src=g;document.body&&document.body.appendChild(a)}};
      this.start=function(){var a=this;window.addEventListener?window.addEventListener("load",function(){a.go()},!1):window.attachEvent&&window.attachEvent("onload",function(){a.go()})}};
      try{(new g(100,"r","QSI_S_ZN_emkP0oSe9Qrn7kF","https://znemkp0ose9qrn7kf-elastic.siteintercept.qualtrics.com/WRSiteInterceptEngine/?Q_ZID=ZN_emkP0oSe9Qrn7kF")).start()}catch(i){}})();
    </script><div id="ZN_emkP0oSe9Qrn7kF"><!--DO NOT REMOVE-CONTENTS PLACED HERE--></div>
    <!--END WEBSITE FEEDBACK SNIPPET-->

    <div id="elastic-nav" style="display:none;"></div>
    <script src="https://www.elastic.co/elastic-nav.js"></script>

    <!-- Subnav -->
    <div>
      <div>
        <div class="tertiary-nav d-none d-md-block">
          <div class="container">
            <div class="p-t-b-15 d-flex justify-content-between nav-container">
              <div class="breadcrum-wrapper"><span><a href="/guide/" style="font-size: 14px; font-weight: 600; color: #000;">Docs</a></span></div>
            </div>
          </div>
        </div>
      </div>
    </div>

    <div class="main-container">
      <section id="content">
        <div class="content-wrapper">

          <section id="guide" lang="en">
            <div class="container">
              <div class="row">
                <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                  <!-- start body -->
                  <div class="page_header">
<strong>IMPORTANT</strong>: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="cat.html">cat APIs</a></span>
»
<span class="breadcrumb-node">cat transforms API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="cat-trained-model.html">« cat trained model API</a>
</span>
<span class="next">
<a href="cluster.html">Cluster APIs »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="cat-transforms"></a>cat transforms API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/transforms.asciidoc">edit</a>
</h2>
</div></div></div>

<p>Returns configuration and usage information about transforms.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-transforms-api-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/transforms.asciidoc">edit</a>
</h3>
</div></div></div>
<p><code class="literal">GET /_cat/transforms/&lt;transform_id&gt;</code><br></p>
<p><code class="literal">GET /_cat/transforms/_all</code><br></p>
<p><code class="literal">GET /_cat/transforms/*</code><br></p>
<p><code class="literal">GET /_cat/transforms</code></p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-transforms-api-prereqs"></a>Prerequisites<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/transforms.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
If the Elasticsearch security features are enabled, you must have <code class="literal">monitor_transform</code>
cluster privileges to use this API. The built-in <code class="literal">transform_user</code> role has these
privileges. For more information, see <a class="xref" href="security-privileges.html" title="Security privileges">Security privileges</a> and
<a class="xref" href="built-in-roles.html" title="Built-in roles">Built-in roles</a>.
</li>
</ul>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-transforms-api-path-params"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/transforms.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;transform_id&gt;</code>
</span>
</dt>
<dd>
(Optional, string)
Identifier for the transform. It can be a transform identifier or a wildcard
expression. If you do not specify one of these options, the API returns
information for all transforms.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-transforms-api-query-params"></a>Query parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/transforms.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">allow_no_match</code>
</span>
</dt>
<dd>
<p>
(Optional, boolean)
Specifies what to do when the request:
</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Contains wildcard expressions and there are no transforms that match.
</li>
<li class="listitem">
Contains the <code class="literal">_all</code> string or no identifiers and there are no matches.
</li>
<li class="listitem">
Contains wildcard expressions and there are only partial matches.
</li>
</ul>
</div>
<p>The default value is <code class="literal">true</code>, which returns an empty <code class="literal">transforms</code> array when
there are no matches and the subset of results when there are partial matches.</p>
<p>If this parameter is <code class="literal">false</code>, the request returns a <code class="literal">404</code> status code when there
are no matches or only partial matches.</p>
</dd>
<dt>
<span class="term">
<code class="literal">format</code>
</span>
</dt>
<dd>
(Optional, string) Short version of the
<a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html" class="ulink" target="_top">HTTP accept header</a>.
Valid values include JSON, YAML, etc.
</dd>
<dt>
<span class="term">
<code class="literal">from</code>
</span>
</dt>
<dd>
(Optional, integer)
Skips the specified number of transforms. The default value is <code class="literal">0</code>.
</dd>
<dt>
<span class="term">
<code class="literal">h</code>
</span>
</dt>
<dd>
<p>
(Optional, string) Comma-separated list of column names to display.
</p>
<p>If you do not specify which columns to include, the API returns the default
columns. If you explicitly specify one or more columns, it returns only the
specified columns.</p>
<p>Valid columns are:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">changes_last_detection_time</code>, <code class="literal">cldt</code>
</span>
</dt>
<dd>
The timestamp when changes were last detected in the source indices.
</dd>
<dt>
<span class="term">
<code class="literal">checkpoint_duration_time_exp_avg</code>, <code class="literal">cdtea</code>, <code class="literal">checkpointTimeExpAvg</code>
</span>
</dt>
<dd>
Exponential moving average of the duration of the checkpoint, in milliseconds.
</dd>
<dt>
<span class="term">
<code class="literal">create_time</code>, <code class="literal">ct</code>, <code class="literal">createTime</code>
</span>
</dt>
<dd>
(Default)
The time the transform was created.
</dd>
<dt>
<span class="term">
<code class="literal">description</code>, <code class="literal">d</code>
</span>
</dt>
<dd>
(Default)
The description of the transform.
</dd>
<dt>
<span class="term">
<code class="literal">dest_index</code>, <code class="literal">di</code>, <code class="literal">destIndex</code>
</span>
</dt>
<dd>
(Default)
The <em>destination index</em> for the transform.
</dd>
<dt>
<span class="term">
<code class="literal">documents_indexed</code>, <code class="literal">doci</code>
</span>
</dt>
<dd>
The number of documents that have been indexed into the destination index
for the transform.
</dd>
<dt>
<span class="term">
<code class="literal">documents_processed</code>, <code class="literal">docp</code>
</span>
</dt>
<dd>
The number of documents that have been processed from the source index of
the transform.
</dd>
<dt>
<span class="term">
<code class="literal">frequency</code>, <code class="literal">f</code>
</span>
</dt>
<dd>
(Default)
The interval between checks for changes in the source indices when the
transform is running continuously. Also determines the retry interval in the
event of transient failures while the transform is searching or indexing. The
minimum value is <code class="literal">1s</code> and the maximum is <code class="literal">1h</code>. The default value is <code class="literal">1m</code>.
</dd>
<dt>
<span class="term">
<code class="literal">id</code>
</span>
</dt>
<dd>
(Default)
Identifier for the transform. This identifier can contain lowercase
alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start
and end with alphanumeric characters.
</dd>
<dt>
<span class="term">
<code class="literal">index_failure</code>, <code class="literal">if</code>
</span>
</dt>
<dd>
The number of indexing failures.
</dd>
<dt>
<span class="term">
<code class="literal">index_time</code>, <code class="literal">itime</code>
</span>
</dt>
<dd>
The amount of time spent indexing, in milliseconds.
</dd>
<dt>
<span class="term">
<code class="literal">index_total</code>, <code class="literal">it</code>
</span>
</dt>
<dd>
The number of indices created.
</dd>
<dt>
<span class="term">
<code class="literal">indexed_documents_exp_avg</code>, <code class="literal">idea</code>
</span>
</dt>
<dd>
Exponential moving average of the number of new documents that have been
indexed.
</dd>
<dt>
<span class="term">
<code class="literal">max_page_search_size</code>, <code class="literal">mpsz</code>
</span>
</dt>
<dd>
(Default)
Defines the initial page size to use for the composite aggregation for each
checkpoint. If circuit breaker exceptions occur, the page size is dynamically
adjusted to a lower value. The minimum value is <code class="literal">10</code> and the maximum is <code class="literal">10,000</code>.
The default value is <code class="literal">500</code>.
</dd>
<dt>
<span class="term">
<code class="literal">pages_processed</code>, <code class="literal">pp</code>
</span>
</dt>
<dd>
The number of search or bulk index operations processed. Documents are
processed in batches instead of individually.
</dd>
<dt>
<span class="term">
<code class="literal">pipeline</code>, <code class="literal">p</code>
</span>
</dt>
<dd>
(Default)
The unique identifier for a <a class="xref" href="pipeline.html" title="Pipeline Definition">pipeline</a>.
</dd>
<dt>
<span class="term">
<code class="literal">processed_documents_exp_avg</code>, <code class="literal">pdea</code>
</span>
</dt>
<dd>
Exponential moving average of the number of documents that have been
processed.
</dd>
<dt>
<span class="term">
<code class="literal">processing_time</code>, <code class="literal">pt</code>
</span>
</dt>
<dd>
The amount of time spent processing results, in milliseconds.
</dd>
<dt>
<span class="term">
<code class="literal">reason</code>, <code class="literal">r</code>
</span>
</dt>
<dd>
If a transform has a <code class="literal">failed</code> state, this property provides details about the
reason for the failure.
</dd>
<dt>
<span class="term">
<code class="literal">search_failure</code>, <code class="literal">sf</code>
</span>
</dt>
<dd>
The number of search failures.
</dd>
<dt>
<span class="term">
<code class="literal">search_time</code>, <code class="literal">stime</code>
</span>
</dt>
<dd>
The amount of time spent searching, in milliseconds.
</dd>
<dt>
<span class="term">
<code class="literal">search_total</code>, <code class="literal">st</code>
</span>
</dt>
<dd>
The number of search operations on the source index for the transform.
</dd>
<dt>
<span class="term">
<code class="literal">source_index</code>, <code class="literal">si</code>, <code class="literal">sourceIndex</code>
</span>
</dt>
<dd>
(Default)
The <em>source indices</em> for the transform. It can be a single index, an index
pattern (for example, <code class="literal">"myindex*"</code>), an array of indices (for example,
<code class="literal">["index1", "index2"]</code>), or an array of index patterns (for example,
<code class="literal">["myindex1-*", "myindex2-*"]</code>.
</dd>
<dt>
<span class="term">
<code class="literal">state</code>, <code class="literal">s</code>
</span>
</dt>
<dd>
<p>
(Default)
The status of the transform, which can be one of the following values:
</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<code class="literal">aborting</code>: The transform is aborting.
</li>
<li class="listitem">
<code class="literal">failed</code>: The transform failed. For more information about the failure,
check the reason field.
</li>
<li class="listitem">
<code class="literal">indexing</code>: The transform is actively processing data and creating new
documents.
</li>
<li class="listitem">
<code class="literal">started</code>: The transform is running but not actively indexing data.
</li>
<li class="listitem">
<code class="literal">stopped</code>: The transform is stopped.
</li>
<li class="listitem">
<code class="literal">stopping</code>: The transform is stopping.
</li>
</ul>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">transform_type</code>, <code class="literal">tt</code>
</span>
</dt>
<dd>
(Default)
Indicates the type of transform: <code class="literal">batch</code> or <code class="literal">continuous</code>.
</dd>
<dt>
<span class="term">
<code class="literal">trigger_count</code>, <code class="literal">tc</code>
</span>
</dt>
<dd>
The number of times the transform has been triggered by the scheduler. For
example, the scheduler triggers the transform indexer to check for updates
or ingest new data at an interval specified in the
<a class="xref" href="put-transform.html#put-transform-request-body" title="Request body"><code class="literal">frequency</code> property</a>.
</dd>
<dt>
<span class="term">
<code class="literal">version</code>, <code class="literal">v</code>
</span>
</dt>
<dd>
(Default)
The version of Elasticsearch that existed on the node when the transform was
created.
</dd>
</dl>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">help</code>
</span>
</dt>
<dd>
(Optional, boolean) If <code class="literal">true</code>, the response includes help information. Defaults
to <code class="literal">false</code>.
</dd>
<dt>
<span class="term">
<code class="literal">s</code>
</span>
</dt>
<dd>
(Optional, string) Comma-separated list of column names or column aliases used
to sort the response.
</dd>
<dt>
<span class="term">
<code class="literal">size</code>
</span>
</dt>
<dd>
(Optional, integer)
Specifies the maximum number of transforms to obtain. The default value is
<code class="literal">100</code>.
</dd>
<dt>
<span class="term">
<code class="literal">time</code>
</span>
</dt>
<dd>
(Optional, <a class="xref" href="common-options.html#time-units" title="Time units">time units</a>)
Unit used to display time values.
</dd>
<dt>
<span class="term">
<code class="literal">v</code>
</span>
</dt>
<dd>
(Optional, boolean) If <code class="literal">true</code>, the response includes column headings.
Defaults to <code class="literal">false</code>.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-transforms-api-examples"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/transforms.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_cat/transforms?v&amp;format=json</pre>
</div>
<div class="console_widget" data-snippet="snippets/1384.console"></div>
<div class="pre_wrapper lang-console-result">
<pre class="programlisting prettyprint lang-console-result">[
  {
    "id" : "ecommerce_transform",
    "create_time" : "2020-03-20T20:31:25.077Z",
    "version" : "7.7.0",
    "source_index" : "kibana_sample_data_ecommerce",
    "dest_index" : "kibana_sample_data_ecommerce_transform",
    "pipeline" : null,
    "description" : "Maximum priced ecommerce data by customer_id in Asia",
    "transform_type" : "continuous",
    "frequency" : "5m",
    "max_page_search_size" : "500",
    "state" : "STARTED"
  }
]</pre>
</div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="cat-trained-model.html">« cat trained model API</a>
</span>
<span class="next">
<a href="cluster.html">Cluster APIs »</a>
</span>
</div>
</div>

                  <!-- end body -->
                </div>
                <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                  <div id="rtpcontainer" style="display: block;">
                    <div class="mktg-promo">
                      <h3>Most Popular</h3>
                      <ul class="icons">
                        <li class="icon-elasticsearch-white"><a href="https://www.elastic.co/webinars/getting-started-elasticsearch?baymax=default&amp;elektra=docs&amp;storm=top-video">Get Started with Elasticsearch: Video</a></li>
                        <li class="icon-kibana-white"><a href="https://www.elastic.co/webinars/getting-started-kibana?baymax=default&amp;elektra=docs&amp;storm=top-video">Intro to Kibana: Video</a></li>
                        <li class="icon-logstash-white"><a href="https://www.elastic.co/webinars/introduction-elk-stack?baymax=default&amp;elektra=docs&amp;storm=top-video">ELK for Logs &amp; Metrics: Video</a></li>
                      </ul>
                    </div>
                  </div>
                </div>
              </div>
            </div>
          </section>

        </div>


<div id="elastic-footer"></div>
<script src="https://www.elastic.co/elastic-footer.js"></script>
<!-- Footer Section end-->

      </section>
    </div>

<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
  window.initial_state = {}</script>
  </body>
</html>
